Microsoft DirectX 8.1 (C++)

IVPBaseConfig::GetOverlaySurface

The GetOverlaySurface method determines whether the overlay mixer should use the driver's overlay surface and if so retrieves a pointer to the surface.

Syntax

HRESULT GetOverlaySurface(
  LPDIRECTDRAWSURFACE *ppddOverlaySurface
);

Parameters

ppddOverlaySurface

[out] Address of a pointer to the retrieved DirectDraw� overlay surface object.

Return Values

Returns S_OK if the overlay surface object was returned. (Default implementation sets the surface to NULL and returns NOERROR.)

Remarks

The Overlay Mixer uses this function to determine if the driver requires the Overlay Mixer to use its overlay surface and if so to get a pointer to it. If this function returns NULL, then the Overlay Mixer allocates its own surface.

See Also